\documentclass[titlepage]{article}
\usepackage[pdftex, bookmarks]{hyperref}
\usepackage[pdftex]{graphicx}
\usepackage{fullpage}
\usepackage{latexsym}
\usepackage{color}
\usepackage{ifthen}
\usepackage[all]{xy}

\begin{document}
\setlength{\parindent}{0pt}
\setlength{\parskip}{12pt}

\title{Registration Tool - Instructions For Use}
\author{Steve Rivers}
\date{\today}
\maketitle
\tableofcontents
\newpage

%--------------------------------------------------------------------
\section{Overview}
%--------------------------------------------------------------------
The registration tool is useful for race day registration. The main flows covered are:

\begin{itemize}
\item Entering riders into fields and categories
\item Generating start lists per field
\item Compiling race results per field
\end{itemize}


%--------------------------------------------------------------------
\section{Terminology}
%--------------------------------------------------------------------
\begin{tabular} { |  l | l  |}
\hline
Field & A field is a race with one or more categories \\ \hline
Category & A Category is any group of riders that will be scored seprately within a field \\
\hline
\end{tabular}

%--------------------------------------------------------------------
\section{Data Sets}
%--------------------------------------------------------------------
The registration tool uses XML to store data. The demands for race day registration don't require a heavy database to support the tool. This section captures the format for each of the XML files used. The current version of the tool does require some upfront setup, mainly with the Fields. 

\subsection{fields.xml}

The fields XML contains the Fields for the event as well as the categories. The Fields and categories are joined on the field identifier. The data members are:

\begin{tabular}{ l l l l }
Type & Memeber & Data Type & Description \\
\hline
Field & FieldId & Integer & Identifier for the field \\
 & FieldName & String & A user defined name for the Field. Example: "W1/2, W3, M45+" \\
 & FieldOpen & Boolean & Set to True If the field is open for registration \\
 & NextBib & Integer & The next bib that will be assigned for the field \\
Category & CategoryId & Integer & Identifier for the category \\
 & CategoryName & String & Name for the Category. Example: "Mens C3" \\
 & CategoryField & Integer & Joins the category with a Field \\
\end{tabular}

\subsection{entries.xml}

The entries XML file contains all the entries for the event. There will be one entry for each categor a rider is participating in. 

\begin{tabular}{ l l l l }
Type & Memeber & Data Type & Description \\
\hline
Entry & EntryId & Integer & Unique identifier for the entry \\
 & Bib & Integer & The bib assigned to the rider for that category \\
 & License & Integer & The riders USAC License number. Will be 0 for one day licenses \\
 & CategoryId & Integer & Joins the rider into a category \\
 & CategoryName & String & Denormalized version of the CategoryName from the Category Type \\
 & FirstName & String & Rider's first name \\
 & LastName & String & Rider's last name \\
 & Club & String & Rider's team or club\\
 & Gender & String & Rider's gender \\
 & Age & Integer & Rider's age \\
\end{tabular}

\subsection{results.xml}
 
The results XML file contains all the results for the event. Results can be listed by field. Overall place is supported, category place will be computed in a future release of the tool. 


\begin{tabular}{ l l l l }
Type & Memeber & Data Type & Description \\
\hline
Result & OverAllPlace & Integer & Riders overall place wihtin this field\\
 & BibNumber & Integer & The bib as identified by the officials within this field \\
 & FieldId & Integer & Joins the result on the field \\
 & CategoryName & String & The name of the category the rider had registered in \\
 & License & Integer & The riders USAC License number. Will be 0 for one day licenses \\
 & FirstName & String & Rider's first name \\
 & LastName & String & Rider's last name \\
 & Club & String & Rider's team or club \\
\end{tabular}



\subsection{mapping.xml}

The mapping XML file is useful when importing registration data from an online registation services (like BikeReg.com) and is used to map that name of the category used on the website to the category ID for the event. For Example, a category on BikeReg.com might have been called "Saturday State CX Mens Categoy 3" but in the tool it's simply called "Mens C3". This XML allows the mapping to take place when the data is imported.


\begin{tabular}{ l l l l }
Type & Memeber & Data Type & Description \\
\hline
Mapping & RaceName & String & The category as it appears in the .csv field\\
 & CategoryId & Integer & The integer identifier used for the field within the fields.xml file \\
\end{tabular}

%--------------------------------------------------------------------
\section{Importing USAC DB}
%--------------------------------------------------------------------

USA Cycling provides promoters with a Database containing all the current license holders. To obtain the database, visit \url{http://www.usacycling.org/promoters} to obtain a copy of the database. Note: The site requires that your profile with USAC has you listed as either an event promoter or a club contact. 

The database can be downloaded in .csv format. The Registration tool expects the data be organized with the columns listed below, in the order specified:



\begin{itemize}
\item license 
\item last name 
\item first name 
\item city 
\item state 
\item gender 
\item racing age 
\item exp date 
\item club 
\item team 
\item NCAA club
\item Cross Cat 
\end{itemize}

%--------------------------------------------------------------------
\section{Features and Usage}
%--------------------------------------------------------------------


%--------------------------------------------------------------------
\section{Revision History}
%--------------------------------------------------------------------
\begin{tabular}[t]{lp{3.5in}}
Date & Change \\
\hline
11/5/11 & Initial Revision \\
\hline
\end{tabular}
\end{document}